home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _printapps / printapps / _formattxt / !FORMATTXT / !HELP < prev    next >
Text File  |  1990-04-05  |  10KB  |  236 lines
  1.  
  2.                                                          
  3.  
  4.                      Help for !FormatTXT
  5.                      ===================
  6.   
  7.        This program is used to format text files. The text
  8.   can  be formatted to fit on pages of a certain width and
  9.   length,  with  page breaks, a header line, and a  footer
  10.   line.  Lines  can  be  justified to  the  Left,  Centre,
  11.   Right,  or both ends, or can be arbitrarily split at the
  12.   end of the line.
  13.   
  14.        The  important options available from the menu  are
  15.   as follows:
  16.   
  17.       * Save as:
  18.        Once  you  have   dragged a  file  to  !FormatTXT's
  19.   iconbar  icon  or into one of it's windows, the Save  as
  20.   option  can  be used to format and save that file  using
  21.   the  present format. This basically allows you to format
  22.   a  single  file   several   times   without   having  to
  23.   repeatedly drag that file to !FormatTXT.
  24.   NOTE: The SAVE AS window consists of 3 parts: a 'normal'
  25.   save  as window, and two yellow buttons labeled 'Printer
  26.   Driver'  (Which  saves  output DIRECT to  any  installed
  27.   printer    driver   (e.g.   !PrinterDM)),   and    'Last
  28.   application'  (Which  will  send  output   to  the  last
  29.   application you saved to by dragging the text icon).
  30.   
  31.       * Justify
  32.        This  brings up the justification  options  window,
  33.   which  allows  you to  select  NO/Left/Centre/Right/Full
  34.   justification.  This  window can also be brought  up  by
  35.   clicking Select on the iconbar icon.
  36.   
  37.       * Format
  38.        This  brings up the (somewhat  more comprehensive!)
  39.   format  window.  This  allows   you   to   set  all  the
  40.   formatting  options  (width,length of page,  etc.).  See
  41.   below  for more information on formats. This window  can
  42.   also  be  brought  up by double-clicking Select  on  the
  43.   iconbar icon.
  44.   
  45.       * Save Format
  46.        This  saves  the  present state of the  format  and
  47.   justify windows as the default format window state. This
  48.   will  be  loaded  every  time  you  run  the  !FormatTXT
  49.   application,  so is a good  short-cut if you want to use
  50.   a  specific  format often. If you want to revert to  the
  51.   original  (default) format, DELETE the file 'Default' in
  52.   the !FormatTXT application directory.
  53.   
  54.   
  55.       Formatting options:
  56.       ===================
  57.        The  following are the options available  from  the
  58.   Format window:
  59.   
  60.        * Page width: The width in characters of the  page.
  61.   This  is  the  TOTAL width, i.e. left and  right  margin
  62.   sizes  will  NOT be ADDED to this width, but rather  are
  63.   included within it.
  64.        Note: If page width minus margins (i.e. actual line
  65.   width)  is  set  to less than 15, (especially  when  <5)
  66.   the Formatting code may lock up. Thus, you will be asked
  67.   before  formatting if you are sure you wish to continue.
  68.   If  the code does lock up, press the ESC key (escape) to
  69.   abort the format.
  70.   
  71.        *  Page  length: The length of the page  in  lines.
  72.   This  is the TOTAL length, i.e. headers/footers etc. are
  73.   not  ADDED  to  the length of the page, but  rather  are
  74.   included within it.
  75.   
  76.        *  Line  Spacing: This controls how  many  newlines
  77.   will  be  printed  at the end of each line  of  text.  A
  78.   value  of  1  outputs text normally. A value  of 2  will
  79.   print  a  blank  line inbetween each of the  text  lines
  80.   printed.  A  value of 3 prints 2 blank lines...  and  so
  81.   on.
  82.   
  83.        * Left and Right Margins: These values control  how
  84.   many  spaces  will be included at the start and  end  of
  85.   each line as margins. Usually these are set to 0.
  86.   
  87.        *  Top  gap:  This is the  number  of  blank  lines
  88.   printed  at the top of each page (used to move down past
  89.   the perforation on continuous stationery).
  90.   
  91.        *  End  gap:  This is the  number  of  blank  lines
  92.   printed  at the end of each page (used to move down past
  93.   the perforation on continuous stationery).
  94.   
  95.        *  Header:  This is a single line of text  that  is
  96.   printed  at  the top of each page. If this line is  left
  97.   blank,  the header line will not be printed at all.  The
  98.   header  can  include  the following  special  sequences,
  99.   which are replaced by other text upon printing:
  100.   
  101.        #F - This  is replaced by the filename of the  file
  102.             being printed.
  103.        #D - This is replaced by the current date e.g. "Sun
  104.             18 Mar, 1990"
  105.        #T - This  is  replaced by the  current  time  e.g.
  106.             "16:02:29"
  107.        #N - This  is replaced on each page by the  present
  108.             page number (starting at 1)
  109.        ## - This is replaced by a single '#'
  110.        #C - This moves all following text into the  centre
  111.             of the line
  112.        #R - This  moves all following text across  to  the
  113.             right of the line
  114.   
  115.        *  Head  gap:  This is the number  of  blank  lines
  116.   inserted  between  the header line an the start  of  the
  117.   text  placed on that page. This also won't be printed if
  118.   the header is left blank.
  119.   
  120.        *  Footer:  This is similar to the header,  but  it
  121.   occurs  at  the  bottom   of   each  page.  The  special
  122.   sequences  can be used here also. It won't be printed if
  123.   it is left blank.
  124.   
  125.        *  Foot gap: Similar to the head gap, this  is  the
  126.   number  of blank lines between the bottom of the text on
  127.   that  page and the footer line. This won't be printed if
  128.   the footer is left blank.
  129.   
  130.        * FF char: This is the character (ASCII value) that
  131.   will  be  printed at the bottom of each page to cause  a
  132.   FORM  FEED. The normal Epson-compatible printer code for
  133.   Form  feed is 12 (This corresponds to 'Clear screen'  on
  134.   the  Archimedes).  Set  this  value  to 0  to  stop  the
  135.   character being output.
  136.   
  137.        * CR char: This is the character (ASCII value) that
  138.   will  be  printed  at  the end of  each  line  (CARRIAGE
  139.   RETURN).  The normal code for a CR is 13. Set this value
  140.   to  0  to  stop  the character  being  output.  On  most
  141.   printers,  only  an LF (see below) needs to be sent,  so
  142.   this is set to 0 by default.
  143.   
  144.        * LF char: This is the character (ASCII value) that
  145.   will  be  printed at the end of each line  (LINE  FEED).
  146.   The  normal code for a LF is 10. Set this value to 0  to
  147.   stop the character being output.
  148.                                                 
  149.   
  150.        The  following options lie in the two boxes in  the
  151.   top  right and top centre of the format window. They are
  152.   all,  by  default,  turned  off. To turn  one  of  these
  153.   options  on, click on the text of the option, or on  the
  154.   box  to  the left of the text with Select- a  tick  will
  155.   appear to show that the option is on.
  156.   
  157.        *  Expand  tabs to [ xx ] spaces: When  turned  on,
  158.   this  will convert any TAB characters (ASCII 9) that  it
  159.   finds  into  spaces- Each tab character is  replaced  by
  160.   'xx' spaces.
  161.   
  162.        * Remove multiple spaces: When on, this option will
  163.   strip  'runs'  of more than one space down to  only  one
  164.   space.  This  helps to strip off indents  and  paragraph
  165.   indents.
  166.   
  167.        *  Remove multiple newlines: When on,  this  option
  168.   strips  'runs'  of  more than one newline (ASCII  10  or
  169.   ASCII  13),  replacing them with a single newline.  This
  170.   can  be used to strip out unwanted 'blank lines' in  the
  171.   text.
  172.   
  173.        *  Auto paragraph indent: When on, this  inserts  5
  174.   spaces  after  every newline it finds. Thus if you  type
  175.   in  paragraphs  as a single continuous piece of text  in
  176.   !Edit,  then  this option will successfully  indent  the
  177.   first line of each paragraph.
  178.   
  179.        *  Remove characters: When turned on,  this  option
  180.   takes  the list of characters in the white writeable box
  181.   to  the right of this option, and deletes any characters
  182.   in  this  list from the text. e.g. If the list  contains
  183.   the  'space' character, then all spaces will be stripped
  184.   from the text. The list is made up as follows:
  185.        Each  character in the list is specified in one  of
  186.   two  forms:  if you type a number, then the it  will  be
  187.   interpreted  as  an  ASCII value. If you  type a  single
  188.   character  enclosed  in single quotes (e.g.  'A'),  then
  189.   that  character  will  be removed from  the  text.  Each
  190.   character in the list is then seperated by commas.
  191.       e.g. To remove all newlines:     10,13
  192.            To remove all TABs:         9
  193.            To  remove all capital A's: 'A'  } either form
  194.            To remove all capital A's:   65  }  will do
  195.            To remove ALL A's: 'A','a'  or  65,97
  196.   
  197.        *  Upper  threshold: This is an  ASCII  value.  Any
  198.   characters  in  the text with ASCII values  higher  than
  199.   (But  NOT  including) this threshold, will  be  deleted.
  200.   This  is   very   good   for   stripping   'Top-bit-set'
  201.   characters  (threshold=127)   that   printers   tend  to
  202.   interpret as commands, causing them to go haywire.
  203.   
  204.        *  Lower  threshold: Similar  to  upper  threshold.
  205.   Again,  this  is an ASCII value. Any characters  in  the
  206.   text  with  ASCII values lower than (But NOT  including)
  207.   this  threshold   (except   for   10,13:   the   newline
  208.   characters)  will be deleted. Generally this is used  to
  209.   filter  out  ASCII  value  less than  32  (space)  (i.e.
  210.   threshold=32),  as these characters tend to cause mayhem
  211.   with printers.
  212.   
  213.        *  Character conversion: The three options  at  the
  214.   far  right  of the format window control how  characters
  215.   are  converted. The default setting is 'No  conversion',
  216.   which  leaves  characters alone. Setting this to  'Force
  217.   uppercase'  will  cause  all   output   text  to  be  in
  218.   uppercase,  while 'Force lowercase' causes all output to
  219.   be in lowercase text.
  220.   
  221.   
  222.          Possible   (with   a   capital   "Poss")   future
  223.   improvements to this application:
  224.       -RAMload/RAMsave direct from/to other applications
  225.       -Incorporate fully functional DTP, Art package, Text
  226.   editor, Memory editor, Program archiver, and a Raytracer 
  227.  
  228.  
  229.   (P.S.  This was written in EDIT, and formatted with  the
  230.   application,  followed  by minor touch-ups by  me.  This
  231.   format  used Full justification, a left margin, and auto
  232.   paragraphing.)
  233.  
  234.   On-line help is available using the !Help application on
  235.   the Applications disc 1 ('App1') disc.
  236.